home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Users Group Library 1996 July / C-C++ Users Group Library July 1996.iso / vol_300 / 300_01 / mat_v2d.abr < prev    next >
Text File  |  1989-12-28  |  28KB  |  588 lines
  1.                            ABREVIATED USERS MANUAL
  2.  
  3.  
  4. The following function description is an example of the function writeups 
  5. provided in the users manual. The remaining descriptive writeups are very 
  6. brief but do describe the syntax and basic use of each function. Regular 
  7. users of this library will find the manual quite helpful.
  8.  
  9.  
  10. ----------------------------------------------------------------------------
  11. mfput
  12. ----------------------------------------------------------------------------
  13. Name              mfput - Outputs selected columns from floating point array 
  14.                   in formatted pages with column titles 
  15.                    
  16. Usage             void mfput ( FILE *FN,struct fmat *mtx,char hdr_lst[], 
  17.                   char sel_lst[], unsigned ChPrLn,unsigned FldPrLn,unsigned 
  18.                   DcPlc);  
  19.  
  20. Prototype in      mat_v2b.h
  21.  
  22. Description       This function outputs selected columns of the floating 
  23.                   point array mtx to FN, which has previously been opened 
  24.                   for text write operations (see mfcreat). 
  25.                   
  26.                   hdr_lst[] is a list of abbreviated titles (tokens 
  27.                   delimited by spaces) for each column in mtx.  sel_lst[] is 
  28.                   list of matching abbreviated titles for the columns which 
  29.                   are to be output.  ChPrLn is the maximum number of 
  30.                   characters per line desired. FldPrLn is the number of 
  31.                   values which are desired on each line, and DcPlc specifies 
  32.                   the number of decimal places desired in the output values. 
  33.                   
  34.                   The columns to be output are selected by performing a 
  35.                   token by token comparison of hdr_lst and sel_lst.  If an 
  36.                   abreviated title token from sel_lst matches a title token 
  37.                   in hdr_lst, that column will be output.  The selected 
  38.                   columns of mtx are output in tabular form without page 
  39.                   breaks with the abbreviated column titles enclosed in 
  40.                   braces at the beginning of the table. 
  41.  
  42.                   If the numeric output format is not possible with the 
  43.                   number of decimal places (DcPlc) and fields per line 
  44.                   (FldPrLn) specified the function will generate an error 
  45.                   message and terminate execution. 
  46.                   
  47. Return value      The value of one is returned on completion. 
  48.  
  49. Source code in    fmx1_v2b.c
  50.      
  51. See also          mfpgput,mtput
  52.  
  53. Example           /*  matrix 
  54.                   [ 1 2 3 4 
  55.                     4 5 6 7
  56.                     7 8 9 10 ]
  57.                   */
  58.  
  59.                   flcreat("DATA.OUT",FN);
  60.                   mfput(FN,matrix,  "COL_A COL_B COL_C COL_D",
  61.                                     "COL_B COL_D",20,2,3);
  62.                   
  63.                   /* The following output will be directed to FN  
  64.                   {   DATA.OUT    12/1/88                                  } 
  65.  
  66.                   {    
  67.                        COL_B      COL_D
  68.                   }
  69.                        2.000      4.000
  70.                        5.000      7.000
  71.                        8.000     10.000
  72.  
  73.  
  74.  
  75.  
  76.                            ABREVIATED DESCRIPTIONS
  77.  
  78.  
  79. ----------------------------------------------------------------------------
  80. all                                                                            
  81. ----------------------------------------------------------------------------
  82. Name              all - Macro to loop through an entire array
  83.                   
  84. Usage             macro as follows: all(mx,rw,cl) 
  85.                      for (rw=0; rw<no_rows(mx); rw++) 
  86.                         for (cl=0; cl<no_cols(mx); cl++)
  87.  
  88. ----------------------------------------------------------------------------
  89. cols
  90. ----------------------------------------------------------------------------
  91. Name              cols - Macro to loop through an entire array by columns
  92.                   
  93. Usage             macro as follows: 
  94.                   cols(mx,cl) for(cl=0;cl<no_cols(mx);cl++)
  95.  
  96. ----------------------------------------------------------------------------
  97. f
  98. ----------------------------------------------------------------------------
  99. Name              f - Macro to access a dynamic floating array value
  100.                    
  101. Usage             float f ( struct fmat *mtx, unsigned row, 
  102.                   unsigned column );
  103.  
  104. ----------------------------------------------------------------------------
  105. fck
  106. ----------------------------------------------------------------------------
  107. Name              fck - Macro to perform a boundary check on a specified set 
  108.                   of array indexes for a previosly declared floating 
  109.                   point dynamic matrix.
  110.                    
  111. Usage             void fck(struct fmat *mtx, unsigned row, unsigned col); 
  112.  
  113.  
  114. ----------------------------------------------------------------------------
  115. fdim
  116. ----------------------------------------------------------------------------
  117. Name              fdim - Macro to allocate storage and initialize a dynamic 
  118.                   floating point array 
  119.                    
  120. Usage             void fdim ( struct fmat *mtx, unsigned rows, 
  121.                   unsigned cols );
  122.  
  123. ----------------------------------------------------------------------------
  124. frel 
  125. ----------------------------------------------------------------------------
  126. Name              frel - Macro to deallocate storage previously allocated by 
  127.                   a call to fdim. 
  128.                    
  129. Usage             void frel(struct fmat *mtx); 
  130.  
  131. ----------------------------------------------------------------------------
  132. flcreat
  133. ----------------------------------------------------------------------------
  134. Name              flcreat - Opens a text file for write operations then 
  135.                   writes a single line containing the filename and date 
  136.                   enclosed in braces
  137.                   
  138. Usage             void flcreat ( char filename[],FILE *FN );
  139.  
  140. ----------------------------------------------------------------------------
  141. ft
  142. ----------------------------------------------------------------------------
  143. Name              ft - Stores a floating point value in a text array as an 
  144.                   ASCII token string.
  145.                   
  146. Usage             void ft (struct tmat *mtx,unsigned line,unsigned token,
  147.                   float value, unsigned ChPrLn,unsigned FldPrLn, 
  148.                   unsigned DcPlc); 
  149.  
  150. ----------------------------------------------------------------------------
  151. it
  152. ----------------------------------------------------------------------------
  153. Name              it - Stores an integer value in a text array as a 
  154.                   token. 
  155.                   
  156. Usage             void it (struct tmat *mtx,unsigned line,unsigned token,
  157.                   unsigned value, unsigned ChPrLn,unsigned FldPrLn);
  158.  
  159. ----------------------------------------------------------------------------
  160. mfcnt
  161. ----------------------------------------------------------------------------
  162. Name              mfcnt - Returns the number of rows and columns in an ASCII 
  163.                   textfile stored in a format standardized for floating 
  164.                   point arrays.  
  165.                    
  166. Usage             void mfcnt (char filename[], unsigned *rows, 
  167.                   unsigned *cols ); 
  168.  
  169. -----------------------------------------------------------------------------
  170. mfcof
  171. -----------------------------------------------------------------------------
  172. Name              mfcof - Returns the cofactor for a dynamic floating point 
  173.                   array element.
  174.                    
  175. Usage             float mfcof (struct fmat *mtx,unsigned i, unsigned j);
  176.  
  177. ----------------------------------------------------------------------------
  178. mfcnt
  179. ----------------------------------------------------------------------------
  180. Name              mfcnt - Returns the number of rows and columns in an